bpo-46209: add documentation for decoding newlines in the io module#30308
bpo-46209: add documentation for decoding newlines in the io module#30308guoci wants to merge 4 commits intopython:mainfrom
io module#30308Conversation
Doc/library/io.rst
Outdated
| .. attribute:: newlines | ||
|
|
||
| a tuple of types of newlines encountered, or the newline if only | ||
| one type of newline is found. |
There was a problem hiding this comment.
The types are not clear here. Are you saying this is a tuple of strings or one string?
There was a problem hiding this comment.
the type is either a string or tuple of strings
Lines 1971 to 1980 in e18d815
There was a problem hiding this comment.
ok! I wouldn’t say types of newlines, unless that phrase is used elsewhere in the docs, it could be confusing.
There was a problem hiding this comment.
how about changing to representations of newlines?
Line 1901 in e18d815
There was a problem hiding this comment.
That sounds a bit abstract to me. These are newlines, meaning strings.
Isn’t there an existing phrase in io docs or dosctrings that can be reused?
There was a problem hiding this comment.
I can't find any in the io docs, The docstring of that class says types of newlines.
There was a problem hiding this comment.
It might be worth just giving some examples.
There was a problem hiding this comment.
Listed all the possible values.
MaxwellDupre
left a comment
MaxwellDupre
left a comment
There was a problem hiding this comment.
Docs complied on my machine. Looks ok.
guoci
force-pushed
the
doc_newline_decoders
branch
2 times, most recently
from
632a7c7 to
0081b76
Compare
guoci
force-pushed
the
doc_newline_decoders
branch
from
0081b76 to
2c73105
Compare
|
@merwok is that ok now? |
8 participants
https://bugs.python.org/issue46209